<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Finder</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> Finder</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
                <p class="implements">
            Implements interfaces:
            <ul>
                <li>IteratorAggregate (internal interface)</li>            </ul>
        </p>
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Finder allows to build rules to find files and directories.</p>
<p class="description"><p>It is a thin wrapper around several specialized iterator classes.</p><p>All rules may be invoked several times.</p><p>All methods return the current Finder object to allow easy chaining:</p><p>$finder = new Finder();  $finder = $finder-&gt;files()-&gt;name('*.php')-&gt;in(__DIR__);</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Fabien Potencier &lt;<a href="mailto:fabien.potencier@symfony-project.com">fabien.potencier@symfony-project.com</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_slinks---common---Finder---Finder.php.html">/slinks/common/Finder/Finder.php</a> (line <span class="field">28</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																																																																																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$dates" title="details" class="var-name">$dates</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$depths" title="details" class="var-name">$depths</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$dirs" title="details" class="var-name">$dirs</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$exclude" title="details" class="var-name">$exclude</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$filters" title="details" class="var-name">$filters</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$followLinks" title="details" class="var-name">$followLinks</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$ignoreVCS" title="details" class="var-name">$ignoreVCS</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$mode" title="details" class="var-name">$mode</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$names" title="details" class="var-name">$names</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$notNames" title="details" class="var-name">$notNames</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$notPaths" title="details" class="var-name">$notPaths</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$paths" title="details" class="var-name">$paths</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$sizes" title="details" class="var-name">$sizes</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$sort" title="details" class="var-name">$sort</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																																								<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#date" title="details" class="method-name">date</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#depth" title="details" class="method-name">depth</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$level</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#directories" title="details" class="method-name">directories</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#exclude" title="details" class="method-name">exclude</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#files" title="details" class="method-name">files</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#filter" title="details" class="method-name">filter</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">\$closure</span>, <span class="var-type">Closure</span>&nbsp;<span class="var-name">$closure</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#followLinks" title="details" class="method-name">followLinks</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">\Iterator</span>
										<a href="#getIterator" title="details" class="method-name">getIterator</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#ignoreVCS" title="details" class="method-name">ignoreVCS</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$ignoreVCS</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#in" title="details" class="method-name">in</a>
											(<span class="var-type">string|array</span>&nbsp;<span class="var-name">$dirs</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#name" title="details" class="method-name">name</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#notName" title="details" class="method-name">notName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#notPathName" title="details" class="method-name">notPathName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#pathName" title="details" class="method-name">pathName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#searchInDirectory" title="details" class="method-name">searchInDirectory</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#size" title="details" class="method-name">size</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$size</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#sort" title="details" class="method-name">sort</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">\$closure</span>, <span class="var-type">Closure</span>&nbsp;<span class="var-name">$closure</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#sortByName" title="details" class="method-name">sortByName</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
										<a href="#sortByType" title="details" class="method-name">sortByType</a>
										()
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$dates" id="$dates"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$dates</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">43</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$depths" id="$depths"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$depths</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">37</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$dirs" id="$dirs"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$dirs</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">42</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$exclude" id="$exclude"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$exclude</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">35</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$filters" id="$filters"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$filters</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">36</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$followLinks" id="$followLinks"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$followLinks</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">39</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$ignoreVCS" id="$ignoreVCS"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$ignoreVCS</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">41</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$mode" id="$mode"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$mode</span>
			 = <span class="var-default"> 0</span>			(line <span class="line-number">30</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$names" id="$names"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$names</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">31</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$notNames" id="$notNames"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$notNames</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">32</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$notPaths" id="$notPaths"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$notPaths</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">34</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$paths" id="$paths"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$paths</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">33</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$sizes" id="$sizes"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$sizes</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">38</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$sort" id="$sort"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$sort</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">40</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methoddate" id="date"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">date</span> (line <span class="line-number">109</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds tests for file dates (last modified).</p>
<p class="description"><p>The date must be something that strtotime() is able to parse:</p><p>$finder-&gt;date('since yesterday');    $finder-&gt;date('until 2 days ago');    $finder-&gt;date('&gt; now - 2 hours');    $finder-&gt;date('&gt;= 2005-10-15');</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Comparator\DateComparator</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\DateRangeFilterIterator</li>
				<li><span class="field">see:</span> <a href="http://www.php.net/strtotime">strtotime</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			date
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$date</span><span class="var-description">: A date rage string</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddepth" id="depth"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">depth</span> (line <span class="line-number">84</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds tests for the directory depth.</p>
<p class="description"><p>Usage:</p><p>$finder-&gt;depth('&gt; 1') // the Finder will start matching at level 1.    $finder-&gt;depth('&lt; 3') // the Finder will descend at most 3 levels of directories below the starting point.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\DepthRangeFilterIterator</li>
				<li><span class="field">see:</span> slinks\common\Finder\Comparator\NumberComparator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			depth
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$level</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$level</span><span class="var-description">: The depth level expression</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddirectories" id="directories"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">directories</span> (line <span class="line-number">50</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restricts the matching to directories only.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			directories
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodexclude" id="exclude"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">exclude</span> (line <span class="line-number">222</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Excludes directories.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\ExcludeDirectoryFilterIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			exclude
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dir</span><span class="var-description">: A directory to exclude</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfiles" id="files"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">files</span> (line <span class="line-number">62</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restricts the matching to files only.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			files
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodfilter" id="filter"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">filter</span> (line <span class="line-number">307</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Filters the iterator with an anonymous function.</p>
<p class="description"><p>The anonymous function receives a \SplFileInfo and must return false  to remove files.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\CustomFilterIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			filter
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">\$closure</span>, <span class="var-type">Closure</span>&nbsp;<span class="var-name">$closure</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Closure</span>
				<span class="var-name">$closure</span><span class="var-description">: An anonymous function</span>			</li>
					<li>
				<span class="var-type">Closure</span>
				<span class="var-name">\$closure</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfollowLinks" id="followLinks"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">followLinks</span> (line <span class="line-number">319</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Forces the following of symlinks.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			followLinks
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetIterator" id="getIterator"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getIterator</span> (line <span class="line-number">361</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an Iterator for the current Finder configuration.</p>
<p class="description"><p>This method implements the IteratorAggregate interface.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> An iterator</li>
				<li><span class="field">throws:</span> \LogicException if the in() method has not been called</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">\Iterator</span>
		<span class="method-name">
			getIterator
		</span>
				()
			</div>
	
		
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt>IteratorAggregate::getIterator</dt>
					</dl>
			
	</div>
<a name="methodignoreVCS" id="ignoreVCS"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">ignoreVCS</span> (line <span class="line-number">236</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Forces the finder to ignore version control directories.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\IgnoreVcsFilterIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			ignoreVCS
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$ignoreVCS</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$ignoreVCS</span>			</li>
				</ul>
		
			
	</div>
<a name="methodin" id="in"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">in</span> (line <span class="line-number">335</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Searches files and directories which match defined rules.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">throws:</span> \InvalidArgumentException if one of the directory does not exist</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			in
		</span>
					(<span class="var-type">string|array</span>&nbsp;<span class="var-name">$dirs</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string|array</span>
				<span class="var-name">$dirs</span><span class="var-description">: A directory path or an array of directories</span>			</li>
				</ul>
		
			
	</div>
<a name="methodname" id="name"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">name</span> (line <span class="line-number">131</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds rules that files must match.</p>
<p class="description"><p>You can use patterns (delimited with / sign), globs or simple strings.</p><p>$finder-&gt;name('*.php')  $finder-&gt;name('/\.php$/') // same as above  $finder-&gt;name('test.php')</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\FilenameFilterIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			name
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pattern</span><span class="var-description">: A pattern (a regexp, a glob, or a string)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodnotName" id="notName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">notName</span> (line <span class="line-number">147</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds rules that files must not match.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\FilenameFilterIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			notName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pattern</span><span class="var-description">: A pattern (a regexp, a glob, or a string)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodnotPathName" id="notPathName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">notPathName</span> (line <span class="line-number">184</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds rules that file paths must not match.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\PathFilterIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			notPathName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pattern</span><span class="var-description">: A pattern (a regexp, a glob, or a string)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodpathName" id="pathName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">pathName</span> (line <span class="line-number">168</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds rules that file paths must match.</p>
<p class="description"><p>You can use patterns (delimited with / sign), globs or simple strings.</p><p>$finder-&gt;path('*.compiler/\*.php')</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\PathFilterIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			pathName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$pattern</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$pattern</span><span class="var-description">: A pattern (a regexp, a glob, or a string)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsearchInDirectory" id="searchInDirectory"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">searchInDirectory</span> (line <span class="line-number">379</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			searchInDirectory
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$dir</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsize" id="size"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">size</span> (line <span class="line-number">206</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds tests for file sizes.</p>
<p class="description"><p>$finder-&gt;size('&gt; 10K');  $finder-&gt;size('&lt;= 1Ki');  $finder-&gt;size(4);</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\SizeRangeFilterIterator</li>
				<li><span class="field">see:</span> slinks\common\Finder\Comparator\NumberComparator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			size
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$size</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$size</span><span class="var-description">: A size range string</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsort" id="sort"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">sort</span> (line <span class="line-number">256</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sorts files and directories by an anonymous function.</p>
<p class="description"><p>The anonymous function receives two \SplFileInfo instances to compare.</p><p>This can be slow as all the matching files and directories must be retrieved for comparison.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\SortableIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			sort
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">\$closure</span>, <span class="var-type">Closure</span>&nbsp;<span class="var-name">$closure</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Closure</span>
				<span class="var-name">$closure</span><span class="var-description">: An anonymous function</span>			</li>
					<li>
				<span class="var-type">Closure</span>
				<span class="var-name">\$closure</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsortByName" id="sortByName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">sortByName</span> (line <span class="line-number">272</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sorts files and directories by name.</p>
<p class="description"><p>This can be slow as all the matching files and directories must be retrieved for comparison.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\SortableIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			sortByName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsortByType" id="sortByType"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">sortByType</span> (line <span class="line-number">288</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sorts files and directories by type (directories before files), then by name.</p>
<p class="description"><p>This can be slow as all the matching files and directories must be retrieved for comparison.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The current Finder instance</li>
				<li><span class="field">see:</span> slinks\common\Finder\Iterator\SortableIterator</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Finder.html">Finder</a></span>
		<span class="method-name">
			sortByType
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Thu, 21 Jul 2011 00:28:41 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>